home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / guide / minixpkguide.lha / MiniXpkGuide.doc / MiniXpkGuide.doc
Encoding:
Text File  |  1995-03-09  |  8.2 KB  |  219 lines
  1. Document $VER MiniXpkGuide.dok 1.0 (08.03.95)
  2.  
  3.                 *********************************
  4.                 *                               *
  5.                 *          MiniXpkGuide         *
  6.                 *          Version 1.0          *
  7.                 *       by Martin Gierich       *
  8.                 *                               *
  9.                 *********************************
  10.  
  11.  
  12.  MiniXpkGuide is a replacement for the AmigaGuide and Multiview command
  13.  with support of XPK-compressed and PowerPacked files.
  14.  
  15.  
  16. 1. Introduction
  17. ===============
  18.  MiniXpkGuide is a replacement for the AmigaGuide and Multiview command
  19.  with support of XPK-compressed and PowerPacked files.
  20.  So you can compress all your documentations, pictures, sounds etc.
  21.  using the XPK-package or Powerpacker and view them with MiniXpkGuide
  22.  without bothering about decrunching.
  23.  
  24.  If you have OS 1.2/1.3, it has no use at all.
  25.  If you have OS 2.0/2.1, you can view ASCII-texts or AmigaGuide-
  26.  databases with it.
  27.  If you have OS 3.0 or better, you can view any type of file which is
  28.  supported by your DataTypes including ASCII-texts and AmigaGuide-
  29.  databases.
  30.  
  31.  MiniXpkGuide can be started from CLI or from Workbench.
  32.  It is pure and therefore can be made resident.
  33.  
  34.  It is in assembler and optimized for size (only 488 bytes long) and
  35.  therefore fits comfortably in one (data-)block on harddisk/floppydisk.
  36.  Small size does not mean that this is a hack; it is fully systemconform !
  37.  
  38. 2. Copyright and Disclaimer
  39. ===========================
  40.  It is a small program, so let us keep this chapter also small:
  41.  MiniXpkGuide is Public Domain !
  42.  Use it at your own risk !
  43.  
  44. 3. Requirements
  45. ===============
  46.  You need at least OS 2.0, but OS 3.0+ is better.
  47.  Ofcourse, you need amigaguide.library in your LIBS: directory
  48.  (you can find it on Aminet or on Fish Disk 920 with documentation,
  49.  but if you have OS 3.0+ you will find it on your Workbench-Disk).
  50.  
  51.  To use XPK-compressed files, you need xpkmaster.library and the right
  52.  xpkcompressor (like xpkNUKE.library).
  53.  To use PowerPacked files, you need powerpacker.library and
  54.  xpkmaster.library.
  55.  To show pictures/play sounds you need OS 3.0+ and the right DataTypes.
  56.  
  57. 4. Distribution
  58. ===============
  59.  These files belong to MiniXpkGuide:
  60.  
  61.  MiniXpkGuide           the main executable. 488 bytes long
  62.  MiniXpkGuide.doc       documentation in ASCII-format, compressed
  63.                         with xpkNUKE for testing
  64.  MiniXpkGuide.guide     documentation in AmigaGuide-format, uncompressed
  65.  MiniXpkGuide.S         Assembler-sourcecode
  66.  MicroGuide             CLI-only Guide-viewer for fun. 132 bytes long
  67.  MicroGuide.S           Assembler-sourcecode
  68.  and some Icons
  69.  
  70.  If you do not have all of them, you had bad luck.
  71.  MicroGuide comes without documentation, see the source for more.
  72.  
  73. 5. Usage
  74. ========
  75.  MiniXpkGuide can be used from CLI or Workbench.
  76.  Usage is nearly the same as of the AmigaGuide-command and
  77.  Environment-variables are used the same way
  78.  (you can find some documentation on Aminet or on Fish Disk 920).
  79.  
  80.  It is pure and therefore can be made resident.
  81.  I suggest you to do so if you use it a lot.
  82.  Maybe you want to rename MiniXpkGuide as AmigaGuide or MultiView and
  83.  replace the old and huge AmigaGuide/MultiView-command.
  84.  
  85. 5.1. CLI-Usage
  86. --------------
  87.  MiniXpkGuide <filename> [DOCUMENT <nodename>] [LINE <linenumber>]
  88.               [PUBSCREEN <screename>] [PORTNAME <rexxportname>]
  89.  
  90.  The command template is: 
  91.  
  92.  DATABASE,DOCUMENT/K,LINE/N,PUBSCREEN/K,PORTNAME/K
  93.  
  94.  DATABASE:
  95.      Name of the file to show. Can be XPK-compressed or PowerPacked.
  96.      If you have OS 2.0/2.1, the file can be an ASCII-text or an
  97.      AmigaGuide-database.
  98.      If you have OS 3.0 or better, the file can be any type which is
  99.      supported by your DataTypes (Text/Guides/Pictures/Sound ...).
  100.  
  101.  PUBSCREEN:
  102.      Name of a Public Screen to open window on. The screen must exist
  103.      before using this. This is case sensitive !
  104.  
  105.  PORTNAME:
  106.      Name of an ARexx-port to create.
  107.  
  108.  The following arguments will only work if showing AmigaGuide-databases:
  109.  
  110.  DOCUMENT:
  111.      Name of the node to start at.
  112.      Fine for online-help in scripts and simple programs.
  113.  
  114.  LINE:
  115.      Number of the line to start displaying from.
  116.      See also DOCUMENT (above).
  117.  
  118. 5.2. Workbench-Usage
  119. --------------------
  120.  No ToolTypes are supported. No annoying requester will appear.
  121.  Just click the icon of MiniXpkGuide, then Shift-doubleclick the
  122.  icon of the file you want to see. That's all :-)
  123.  Or use it as default tool.
  124.  You can use it from the Workbench's menu-item "Execute Command", too,
  125.  but this is no real Workbench usage, see `CLI-Usage' for more.
  126.  
  127. 6. Problems and Notes
  128. =====================
  129.  Amigaguide.library V34 has a bug which is fully supported by the
  130.  standard AmigaGuide command. Every time it is started from Workbench
  131.  it forgets to free a lock on the directory the file was in. So write
  132.  accesses to that directory will fail !
  133.  MiniXpkGuide, ofcourse, has a workaround for this bug, so it will not
  134.  appear with it.
  135.  
  136.  MiniXpkGuide will not suck you with frustrating errormessages, it will
  137.  exit quietly (and systemfriendly !) after an error has occured.
  138.  But there are only few errors possible:
  139.  - Workbench-start: Doubleclick on MiniXpkGuide-Icon or Shift-selected
  140.    more than one file
  141.  - CLI-start: No filename given or file not found (anyway, I do not know
  142.    how to catch this error)
  143.  - General: amigaguide.library not in libs: directory
  144.  
  145.  I was both astonished and impressed when I saw that with OS 3.0 and a
  146.  picture-file the picture came up. I had guessed that only some fancy
  147.  characters would appear in the AmigaGuide-window. It seems to be an
  148.  undocumented feature in amigaguide.library V39, that the given
  149.  filename will only be handed through to datatypes.library which could
  150.  show pictures, too. Same with sounds.
  151.  
  152. 7. Future and History
  153. =====================
  154.  Possible things that could be done:
  155.  - filerequester
  156.  - open window on own screen
  157.  - ToolTypes
  158.  - patch for 68000-CPU to be as fast as 68060/50MHz-CPU :-)
  159.  
  160.  I do not have planned these improvements, so if you want to see them
  161.  (or other things) made, you need to convince me to do so.
  162.  
  163.  I wrote this program because I have seen XPKGuide from Simon Dick and
  164.  I liked the idea to use compressed documentations. But unfortunately
  165.  XPKGuide cannot be made resident, and therefore needs to be loaded every
  166.  time from disk. I played around with amigaguide.library anyway to
  167.  implement a viewer in the great ZShell, and with the XPK-package to
  168.  use XPK-compressed executables, texts and guides with ZShell.
  169.  So MiniXpkGuide was some kind of dropping (but it is NO HACK !).
  170.  
  171.  XPKGuide has Filerequesters, own Screens, Application-Icon, ToolTypes,
  172.  supports lots of crunchers and hopefully the next version can be made
  173.  resident. XPKGuide is a real "adult proggie": It is 16548 bytes long.
  174.  
  175. 8. Credits and Author
  176. =====================
  177.  Credits go to
  178.  - Simon Dick for his XPKGuide I took the idea from
  179.    (Sorry Simon, but it just happened that I coded this)
  180.  - the writers of the amigaguide.library for their great Hypertext system
  181.  - the authors of the XPK-package (UD. Müller, B. Ford, C. Schneider)
  182.  - Nico Francois for his powerpacker.library
  183.  - the one who created the icons I took (I do not know where I found it)
  184.  - Stefan Sürken for his Text2Guide
  185.  - all the ZShell users (have a look at it !)
  186.  - and to all future users of this proggie :-)
  187.  - (have I forgotten anybody ?)
  188.  
  189.  
  190.  Please send comments, bug reports, suggestions for future improvements
  191.  or just a "Hello !"
  192.  
  193.  to my snail-mail address:
  194.  
  195.       Martin Gierich
  196.       Narzissenweg 7
  197.       76297 Stutensee
  198.       Germany
  199.  
  200.  or to one of my EMail-addresses:
  201.  
  202.       uj3w@rz.uni-karlsruhe.de
  203.       uj3w@ibm3090.rz.uni-karlsruhe.de
  204.  
  205.  I will try to reply EVERY EMail I get !
  206.  
  207.  MiniXpkGuide was developped on an A500 using OS 2.1, 200 MB of Harddisk,
  208.  1 MB of Chip RAM, 2 MB of real Fast RAM, the oldish EGS-chipset and a
  209.  VGA-Monitor with Flicker-Fixer running at 70 Hz framerate using NTSC
  210.  interlaced 8-colour mode.
  211.  I have not used my DeskJet 500C printer, my A570 CDROM drive and my
  212.  Vortex ATONCE AT-emulator (the last two like to crash very often !).
  213.  Most time of writing I have listened to the SWF 3 radio station 8-)
  214.  
  215.  
  216.    /\/\                 "Life is not good by default,
  217.   / __ \ artin          you have to configure it"
  218.  (_/  \_)               uj3w@rz.uni-karlsruhe.de (Martin Gierich)
  219.